Refactor tctl InitFunc to return an authclient.ClientI #51093
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Returning the interface from the InitFunc allows tests to better mock the auth client, which permits tests to be run without an actual teleport process being launched. The ClientI interface was also extended with additional methods that tctl was already relying on.
rosstimothy
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Returning the interface from the InitFunc allows tests to better mock the auth client, which permits tests to be run without an actual teleport process being launched.
The ClientI interface was also extended with additional methods that tctl was already relying on.
Motivation for this change is to permit writing tests for tctl commands that do not require a teleport process be running. For instance, tests that only exist to validate output of a tctl command given different configurations are now able to do so by mocking out response from auth instead of starting a process and updating the cluster auth preference for each test case.